/*-------------------------------------------------------------------------
 *
 * kwlookup.h
 *	  PostgreSQL 的关键字查找
 *
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/common/kwlookup.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef KWLOOKUP_H
#define KWLOOKUP_H

/* ScanKeywordLookup 使用的哈希函数 */
typedef int (*ScanKeywordHashFunc) (const void *key, size_t keylen);

/*
 * 此结构包含 ScanKeywordLookup 在一组关键字中执行搜索所需的数据。
 * 内容通常由 src/tools/gen_keywordlist.pl 从包含 PG_KEYWORD 宏的头文件生成。
 */
typedef struct ScanKeywordList
{
	const char *kw_string;		/* 按顺序排列的所有关键字，用 \0 分隔 */
	const uint16 *kw_offsets;	/* 每个关键字的起始位置偏移量 */
	ScanKeywordHashFunc hash;	/* 关键字的完美哈希函数 */
	int			num_keywords;	/* 关键字数量 */
	int			max_kw_len;		/* 最长关键字的长度 */
} ScanKeywordList;


extern int	ScanKeywordLookup(const char *text, const ScanKeywordList *keywords);

/* 想要检索第 N 个关键字文本的代码应使用这个。 */
static inline const char *
GetScanKeyword(int n, const ScanKeywordList *keywords)
{
	return keywords->kw_string + keywords->kw_offsets[n];
}

#endif							/* KWLOOKUP_H */
